#!/usr/bin/python
# -*- coding: utf-8 -*-

#This file is part of pyLot library.
#
# pyLot is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# pyLot is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with pyLot.  If not, see <http://www.gnu.org/licenses/>.

__author__ = u'Pierre Puiseux, Guillaume Baty'
__copyright__ = u"Copyright 2011-2012 (C) andheo, Université de Pau et des Pays de l'Adour"
__credits__ = [u'Pierre Puiseux', u'Guillaume Baty']
__license__ = "GNU Lesser General Public License"

__all__ = [u'BaseWidget']

"""

Default implementation of IBaseWidget
"""
from traits.api import implements
from ..interfaces.i_basewidget import IBaseWidget

class BaseWidget(object):
  u"""
  Un widget vide, avec une interface pyLot.
  
  .. warning ::
  
    Name is WidgetInterface and not WidgetInterface because class isn't
    based on QWidget.  
    
  Un widget pyLot propose au minimum 

    - un menu (:meth:`getMenu` et :meth:`menu_`)
    - une tool bar (:meth:`getToolBar`)
    - un editeur de preferences (:meth:`getPreferences`)
  
  Un widget pyLot doit nécessairement être associé à un handler qui s'occupe 
  des traitements de données.
  
  NOTE POUR DOC: parler de l'ordre d'appel des méthodes recursives 
  switchUserLevel, translate, ...
  L'ordre d'exécution est le suivant :
    appel/installation des méthodes globales (niveau pylot)
    appel des méthodes des enfants (car ceux-ci sont 100% indépendant)
    appel des méthodes des pref si dispo
    appel de la méthode locale au widget (car le widget peut dépendre de l'état
    de ses enfants)
  """
  implements(IBaseWidget)

